import "@site/src/languages/highlight";

# Sprite的类对象

**描述：**

&emsp;&emsp;用于创建新的图元对象的类。

**用法示例：**
```tl
local Sprite = require("Sprite")
local sprite = Sprite("Image/file.png")
```

## getClips

**类型：** 函数。

**描述：**

&emsp;&emsp;从图集切片文件中获取切片名称和矩形区域。

**签名：**
```tl
getClips: function(self: SpriteClass, clipFile: string): {string: Rect} | nil
```

**参数：**

| 参数名 | 类型 | 描述 |
| --- | --- | --- |
| clipFile | string | 要加载的图集切片文件，文件后缀名必须是".clip"。 |

**返回值：**

| 返回类型 | 描述 |
| --- | --- |
| \{string: Rect} \| nil | 包含切片名称和矩形区域的表。 |

## __call

**类型：** 元方法。

**描述：**

&emsp;&emsp;用于创建新的图元对象的元方法。

**签名：**
```tl
metamethod __call: function(self: SpriteClass, clipStr: string): Sprite | nil
```

**参数：**

| 参数名 | 类型 | 描述 |
| --- | --- | --- |
| clipStr | string | 包含要加载的纹理文件名的字符串。<br/>可以是"Image/file.png"或"Image/items.clip|itemA"。支持的图片文件格式包括：jpg，png，dds，pvr，ktx。 |

**返回值：**

| 返回类型 | 描述 |
| --- | --- |
| Sprite \| nil | 新的图元对象。如果加载失败则返回nil。 |

## __call

**类型：** 元方法。

**描述：**

&emsp;&emsp;用于创建新的图元对象的元方法。

**签名：**
```tl
metamethod __call: function(self: SpriteClass): Sprite
```

**返回值：**

| 返回类型 | 描述 |
| --- | --- |
| Sprite | 新的图元对象。 |

## __call

**类型：** 元方法。

**描述：**

&emsp;&emsp;用于创建新的图元对象的元方法。

**签名：**
```tl
metamethod __call: function(self: SpriteClass, texture: Texture2D, textureRect?: Rect): Sprite
```

**参数：**

| 参数名 | 类型 | 描述 |
| --- | --- | --- |
| texture | Texture2D | 要渲染的纹理。 |
| textureRect | Rect | [可选] 用于渲染的纹理矩形区域，没有提供则设置为渲染所有纹理区域。 |

**返回值：**

| 返回类型 | 描述 |
| --- | --- |
| Sprite | 新的图元对象。 |